home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / man.3 / Interp.3 < prev    next >
Text File  |  1995-07-17  |  10KB  |  314 lines
  1. '\"
  2. '\" Copyright (c) 1989-1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/Interp.3,v 1.10 93/04/01 09:25:32 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .\" The definitions below are for supplemental macros used in Tcl/Tk
  24. .\" manual entries.
  25. .\"
  26. .\" .HS name section [date [version]]
  27. .\"    Replacement for .TH in other man pages.  See below for valid
  28. .\"    section names.
  29. .\"
  30. .\" .AP type name in/out [indent]
  31. .\"    Start paragraph describing an argument to a library procedure.
  32. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  33. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  34. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  35. .\"    needed;  use .AS below instead)
  36. .\"
  37. .\" .AS [type [name]]
  38. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  39. .\"    name are examples of largest possible arguments that will be passed
  40. .\"    to .AP later.  If args are omitted, default tab stops are used.
  41. .\"
  42. .\" .BS
  43. .\"    Start box enclosure.  From here until next .BE, everything will be
  44. .\"    enclosed in one large box.
  45. .\"
  46. .\" .BE
  47. .\"    End of box enclosure.
  48. .\"
  49. .\" .VS
  50. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  51. .\"    of man pages.
  52. .\"
  53. .\" .VE
  54. .\"    End of vertical sidebar.
  55. .\"
  56. .\" .DS
  57. .\"    Begin an indented unfilled display.
  58. .\"
  59. .\" .DE
  60. .\"    End of indented unfilled display.
  61. .\"
  62. '\"    # Heading for Tcl/Tk man pages
  63. .de HS
  64. .ds ^3 \\0
  65. .if !"\\$3"" .ds ^3 \\$3
  66. .if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
  67. .if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
  68. .if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
  69. .if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
  70. .if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
  71. .if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
  72. .if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
  73. .if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
  74. .if t .wh -1.3i ^B
  75. .nr ^l \\n(.l
  76. .ad b
  77. ..
  78. '\"    # Start an argument description
  79. .de AP
  80. .ie !"\\$4"" .TP \\$4
  81. .el \{\
  82. .   ie !"\\$2"" .TP \\n()Cu
  83. .   el          .TP 15
  84. .\}
  85. .ie !"\\$3"" \{\
  86. .ta \\n()Au \\n()Bu
  87. \&\\$1    \\fI\\$2\\fP    (\\$3)
  88. .\".b
  89. .\}
  90. .el \{\
  91. .br
  92. .ie !"\\$2"" \{\
  93. \&\\$1    \\fI\\$2\\fP
  94. .\}
  95. .el \{\
  96. \&\\fI\\$1\\fP
  97. .\}
  98. .\}
  99. ..
  100. '\"    # define tabbing values for .AP
  101. .de AS
  102. .nr )A 10n
  103. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  104. .nr )B \\n()Au+15n
  105. .\"
  106. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  107. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  108. ..
  109. '\"    # BS - start boxed text
  110. '\"    # ^y = starting y location
  111. '\"    # ^b = 1
  112. .de BS
  113. .br
  114. .mk ^y
  115. .nr ^b 1u
  116. .if n .nf
  117. .if n .ti 0
  118. .if n \l'\\n(.lu\(ul'
  119. .if n .fi
  120. ..
  121. '\"    # BE - end boxed text (draw box now)
  122. .de BE
  123. .nf
  124. .ti 0
  125. .mk ^t
  126. .ie n \l'\\n(^lu\(ul'
  127. .el \{\
  128. .\"    Draw four-sided box normally, but don't draw top of
  129. .\"    box if the box started on an earlier page.
  130. .ie !\\n(^b-1 \{\
  131. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  132. .\}
  133. .el \}\
  134. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  135. .\}
  136. .\}
  137. .fi
  138. .br
  139. .nr ^b 0
  140. ..
  141. '\"    # VS - start vertical sidebar
  142. '\"    # ^Y = starting y location
  143. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  144. .de VS
  145. .mk ^Y
  146. .ie n 'mc \s12\(br\s0
  147. .el .nr ^v 1u
  148. ..
  149. '\"    # VE - end of vertical sidebar
  150. .de VE
  151. .ie n 'mc
  152. .el \{\
  153. .ev 2
  154. .nf
  155. .ti 0
  156. .mk ^t
  157. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  158. .sp -1
  159. .fi
  160. .ev
  161. .\}
  162. .nr ^v 0
  163. ..
  164. '\"    # Special macro to handle page bottom:  finish off current
  165. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  166. '\"    # page bottom macro.
  167. .de ^B
  168. .ev 2
  169. 'ti 0
  170. 'nf
  171. .mk ^t
  172. .if \\n(^b \{\
  173. .\"    Draw three-sided box if this is the box's first page,
  174. .\"    draw two sides but no top otherwise.
  175. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  176. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  177. .\}
  178. .if \\n(^v \{\
  179. .nr ^x \\n(^tu+1v-\\n(^Yu
  180. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  181. .\}
  182. .bp
  183. 'fi
  184. .ev
  185. .if \\n(^b \{\
  186. .mk ^y
  187. .nr ^b 2
  188. .\}
  189. .if \\n(^v \{\
  190. .mk ^Y
  191. .\}
  192. ..
  193. '\"    # DS - begin display
  194. .de DS
  195. .RS
  196. .nf
  197. .sp
  198. ..
  199. '\"    # DE - end display
  200. .de DE
  201. .fi
  202. .RE
  203. .sp .5
  204. ..
  205. .HS Tcl_Interp tclc
  206. .BS
  207. .SH NAME
  208. Tcl_Interp \- client-visible fields of interpreter structures
  209. .SH SYNOPSIS
  210. .nf
  211. \fB#include <tcl.h>\fR
  212. .sp
  213. typedef struct {
  214.     char *\fIresult\fR;
  215.     Tcl_FreeProc *\fIfreeProc\fR;
  216.     int \fIerrorLine\fR;
  217. } Tcl_Interp;
  218.  
  219. typedef void Tcl_FreeProc(char *\fIblockPtr\fR);
  220. .BE
  221.  
  222. .SH DESCRIPTION
  223. .PP
  224. The \fBTcl_CreateInterp\fR procedure returns a pointer to a Tcl_Interp
  225. structure.  This pointer is then passed into other Tcl procedures
  226. to process commands in the interpreter and perform other operations
  227. on the interpreter.  Interpreter structures contain many many fields
  228. that are used by Tcl, but only three that may be accessed by
  229. clients:  \fIresult\fR, \fIfreeProc\fR, and \fIerrorLine\fR.
  230. .PP
  231. The \fIresult\fR and \fIfreeProc\fR fields are used to return
  232. results or error messages from commands.
  233. This information is returned by command procedures back to \fBTcl_Eval\fR,
  234. and by \fBTcl_Eval\fR back to its callers.
  235. The \fIresult\fR field points to the string that represents the
  236. result or error message, and the \fIfreeProc\fR field tells how
  237. to dispose of the storage for the string when it isn't needed anymore.
  238. The easiest way for command procedures to manipulate these
  239. fields is to call procedures like \fBTcl_SetResult\fR
  240. or \fBTcl_AppendResult\fR;  they
  241. will hide all the details of managing the fields.
  242. The description below is for those procedures that manipulate the
  243. fields directly.
  244. .PP
  245. Whenever a command procedure returns, it must ensure
  246. that the \fIresult\fR field of its interpreter points to the string
  247. being returned by the command.
  248. The \fIresult\fR field must always point to a valid string.
  249. If a command wishes to return no result then \fIinterp->result\fR
  250. should point to an empty string.
  251. Normally, results are assumed to be statically allocated,
  252. which means that the contents will not change before the next time
  253. \fBTcl_Eval\fR is called or some other command procedure is invoked.
  254. In this case, the \fIfreeProc\fR field must be zero.
  255. Alternatively, a command procedure may dynamically
  256. allocate its return value (e.g. using \fBmalloc\fR)
  257. and store a pointer to it in \fIinterp->result\fR.
  258. In this case, the command procedure must also set \fIinterp->freeProc\fR
  259. to the address of a procedure that can free the value (usually \fBfree\fR).
  260. If \fIinterp->freeProc\fR is non-zero, then Tcl will call \fIfreeProc\fR
  261. to free the space pointed to by \fIinterp->result\fR before it
  262. invokes the next command.
  263. If a client procedure overwrites \fIinterp->result\fR when
  264. \fIinterp->freeProc\fR is non-zero, then it is responsible for calling
  265. \fIfreeProc\fR to free the old \fIinterp->result\fR (the \fBTcl_FreeResult\fR
  266. macro should be used for this purpose).
  267. .PP
  268. \fIFreeProc\fR should have arguments and result that match the
  269. \fBTcl_FreeProc\fR declaration above:  it receives a single
  270. argument which is a pointer to the result value to free.
  271. In most applications \fBfree\fR is the only non-zero value ever
  272. used for \fIfreeProc\fR.
  273. However, an application may store a different procedure address
  274. in \fIfreeProc\fR in order to use an alternate memory allocator
  275. or in order to do other cleanup when the result memory is freed.
  276. .PP
  277. As part of processing each command, \fBTcl_Eval\fR initializes
  278. \fIinterp->result\fR
  279. and \fIinterp->freeProc\fR just before calling the command procedure for
  280. the command.  The \fIfreeProc\fR field will be initialized to zero,
  281. and \fIinterp->result\fR will point to an empty string.  Commands that
  282. do not return any value can simply leave the fields alone.
  283. Furthermore, the empty string pointed to by \fIresult\fR is actually
  284. part of an array of \fBTCL_RESULT_SIZE\fR characters (approximately 200).
  285. If a command wishes to return a short string, it can simply copy
  286. it to the area pointed to by \fIinterp->result\fR.  Or, it can use
  287. the sprintf procedure to generate a short result string at the location
  288. pointed to by \fIinterp->result\fR.
  289. .PP
  290. It is a general convention in Tcl-based applications that the result
  291. of an interpreter is normally in the initialized state described
  292. in the previous paragraph.
  293. Procedures that manipulate an interpreter's result (e.g. by
  294. returning an error) will generally assume that the result
  295. has been initialized when the procedure is called.
  296. If such a procedure is to be called after the result has been
  297. changed, then \fBTcl_ResetResult\fR should be called first to
  298. reset the result to its initialized state.
  299. .PP
  300. The \fIerrorLine\fR
  301. field is valid only after \fBTcl_Eval\fR returns
  302. a \fBTCL_ERROR\fR return code.  In this situation the \fIerrorLine\fR
  303. field identifies the line number of the command being executed when
  304. the error occurred.  The line numbers are relative to the command
  305. being executed:  1 means the first line of the command passed to
  306. \fBTcl_Eval\fR, 2 means the second line, and so on.
  307. The \fIerrorLine\fR field is typically used in conjunction with
  308. \fBTcl_AddErrorInfo\fR to report information about where an error
  309. occurred.
  310. \fIErrorLine\fR should not normally be modified except by \fBTcl_Eval\fR.
  311.  
  312. .SH KEYWORDS
  313. free, initialized, interpreter, malloc, result
  314.